<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>board_common: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">board_common
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group___overview.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga02dab3acd290a218e441d08199454338"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga02dab3acd290a218e441d08199454338">XRFClk_WriteReg</a> (u32 ChipId, u32 d)</td></tr>
<tr class="memdesc:ga02dab3acd290a218e441d08199454338"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to write a register on one of LMX2594 or LMX04828.  <a href="#ga02dab3acd290a218e441d08199454338">More...</a><br/></td></tr>
<tr class="separator:ga02dab3acd290a218e441d08199454338"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa23f2bf94b86f37357a00a9a2f11f468"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gaa23f2bf94b86f37357a00a9a2f11f468">XRFClk_ReadReg</a> (u32 ChipId, u32 *d)</td></tr>
<tr class="memdesc:gaa23f2bf94b86f37357a00a9a2f11f468"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to read a register from one of LMX2594 or LMX04828.  <a href="#gaa23f2bf94b86f37357a00a9a2f11f468">More...</a><br/></td></tr>
<tr class="separator:gaa23f2bf94b86f37357a00a9a2f11f468"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a7296352a6f5ff2b511184ee95f496b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga5a7296352a6f5ff2b511184ee95f496b">XRFClk_Init</a> (int GpioId)</td></tr>
<tr class="memdesc:ga5a7296352a6f5ff2b511184ee95f496b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to initialize RFCLK devices on i2c1-bus: i2c1 bus switch, i2c2spi bridge and MUX_SELx GPIOs.  <a href="#ga5a7296352a6f5ff2b511184ee95f496b">More...</a><br/></td></tr>
<tr class="separator:ga5a7296352a6f5ff2b511184ee95f496b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga355749ea0ace53f613f5225eda186a55"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga355749ea0ace53f613f5225eda186a55">XRFClk_Close</a> (void)</td></tr>
<tr class="memdesc:ga355749ea0ace53f613f5225eda186a55"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to close RFCLK devices.  <a href="#ga355749ea0ace53f613f5225eda186a55">More...</a><br/></td></tr>
<tr class="separator:ga355749ea0ace53f613f5225eda186a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0b716c787b95513649b2fcba33b3b95"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gae0b716c787b95513649b2fcba33b3b95">XRFClk_ResetChip</a> (u32 ChipId)</td></tr>
<tr class="memdesc:gae0b716c787b95513649b2fcba33b3b95"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to reset one of LMX2594 or LMK04828.  <a href="#gae0b716c787b95513649b2fcba33b3b95">More...</a><br/></td></tr>
<tr class="separator:gae0b716c787b95513649b2fcba33b3b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64c1af6644e83e169033afab6abcf344"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga64c1af6644e83e169033afab6abcf344">XRFClk_SetConfigOnOneChipFromConfigId</a> (u32 ChipId, u32 ConfigId)</td></tr>
<tr class="memdesc:ga64c1af6644e83e169033afab6abcf344"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to set a full configuration on one of LMX2594 or LMX04828 for the requested frequency.where the register settings is provided from the selected hard coded data.  <a href="#ga64c1af6644e83e169033afab6abcf344">More...</a><br/></td></tr>
<tr class="separator:ga64c1af6644e83e169033afab6abcf344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga094020b0514371f05b8848e1454f0345"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga094020b0514371f05b8848e1454f0345">XRFClk_SetConfigOnOneChip</a> (u32 ChipId, u32 *CfgData, u32 Len)</td></tr>
<tr class="memdesc:ga094020b0514371f05b8848e1454f0345"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to set the full configuration data on one of LMX2594 or LMX04828.  <a href="#ga094020b0514371f05b8848e1454f0345">More...</a><br/></td></tr>
<tr class="separator:ga094020b0514371f05b8848e1454f0345"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7820c4fffaa739e2c61e0ad2442e38d2"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga7820c4fffaa739e2c61e0ad2442e38d2">XRFClk_SetConfigOnAllChipsFromConfigId</a> (u32 ConfigId_LMK, u32 ConfigId_1, u32 ConfigId_2)</td></tr>
<tr class="memdesc:ga7820c4fffaa739e2c61e0ad2442e38d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to set a full configuration on all LMX2594 and LMK04828 or LMK04208 for the requested frequency.  <a href="#ga7820c4fffaa739e2c61e0ad2442e38d2">More...</a><br/></td></tr>
<tr class="separator:ga7820c4fffaa739e2c61e0ad2442e38d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadb22b9c390457253f2bfdf773791d270"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gadb22b9c390457253f2bfdf773791d270">XRFClk_GetConfigFromOneChip</a> (u32 ChipId, u32 *CfgData)</td></tr>
<tr class="memdesc:gadb22b9c390457253f2bfdf773791d270"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to read the full configuration data from one of LMX2594 or LMX04828.  <a href="#gadb22b9c390457253f2bfdf773791d270">More...</a><br/></td></tr>
<tr class="separator:gadb22b9c390457253f2bfdf773791d270"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafcd7bee4fa0f626f4d5ae3db8c8adea7"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#gafcd7bee4fa0f626f4d5ae3db8c8adea7">XRFClk_ControlOutputPortLMK</a> (u32 PortId, u32 State)</td></tr>
<tr class="memdesc:gafcd7bee4fa0f626f4d5ae3db8c8adea7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to enable or disable the specified output port on LMK04828.  <a href="#gafcd7bee4fa0f626f4d5ae3db8c8adea7">More...</a><br/></td></tr>
<tr class="separator:gafcd7bee4fa0f626f4d5ae3db8c8adea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga91a0033a744f217741b6bf0125914407"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___overview.html#ga91a0033a744f217741b6bf0125914407">XRFClk_ConfigOutputDividerAndMUXOnLMK</a> (u32 PortId, u32 DCLKoutX_DIV, u32 DCLKoutX_MUX, u32 SDCLKoutY_MUX, u32 SYSREF_DIV)</td></tr>
<tr class="memdesc:ga91a0033a744f217741b6bf0125914407"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to configure a clock divider and the output port MUX state on LMK04828.  <a href="#ga91a0033a744f217741b6bf0125914407">More...</a><br/></td></tr>
<tr class="separator:ga91a0033a744f217741b6bf0125914407"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga355749ea0ace53f613f5225eda186a55"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XRFClk_Close </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to close RFCLK devices. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">none</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="ga91a0033a744f217741b6bf0125914407"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_ConfigOutputDividerAndMUXOnLMK </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>PortId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DCLKoutX_DIV</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>DCLKoutX_MUX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>SDCLKoutY_MUX</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>SYSREF_DIV</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to configure a clock divider and the output port MUX state on LMK04828. </p>
<p>For the details consult tables 16, 18, 19 and 25 in the lmk04828.pdf datasheet.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">PortId</td><td>indicates a LMK04828 port id, [1:7]. </td></tr>
    <tr><td class="paramname">DCLKoutX_DIV</td><td>sets divider for the clock output [0:31]. </td></tr>
    <tr><td class="paramname">DCLKoutX_MUX</td><td>selects input to the device clk buffer [0:3]. </td></tr>
    <tr><td class="paramname">SDCLKoutY_MUX</td><td>sets input to SDCLKoutY [0:1]. </td></tr>
    <tr><td class="paramname">SYSREF_DIV</td><td>sets SYSREF output divider [8:8191]</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group___overview.html#ga02dab3acd290a218e441d08199454338">XRFClk_WriteReg()</a>.</p>

</div>
</div>
<a class="anchor" id="gafcd7bee4fa0f626f4d5ae3db8c8adea7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_ControlOutputPortLMK </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>PortId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>State</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to enable or disable the specified output port on LMK04828. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">PortId</td><td>indicates a LMK04828 port id, [1:7]. </td></tr>
    <tr><td class="paramname">State</td><td>indicates the state of the port, see chapter 9.7.2.7 in lmk04828.pdf datasheet, [0:7]</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group___overview.html#ga02dab3acd290a218e441d08199454338">XRFClk_WriteReg()</a>.</p>

</div>
</div>
<a class="anchor" id="gadb22b9c390457253f2bfdf773791d270"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_GetConfigFromOneChip </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ChipId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>CfgData</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to read the full configuration data from one of LMX2594 or LMX04828. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ChipId</td><td>indicates the RF clock chip Id. </td></tr>
    <tr><td class="paramname">CfgData</td><td>the array of the RF clock chip configuration data.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="ga5a7296352a6f5ff2b511184ee95f496b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_Init </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>GpioId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to initialize RFCLK devices on i2c1-bus: i2c1 bus switch, i2c2spi bridge and MUX_SELx GPIOs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">none</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GpioId gpio ID for Linux build, n/a for baremetal build.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="gaa23f2bf94b86f37357a00a9a2f11f468"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_ReadReg </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ChipId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>d</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to read a register from one of LMX2594 or LMX04828. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ChipId</td><td>indicates the RF clock chip Id. </td></tr>
    <tr><td class="paramname">d</td><td>= {D2, D1, D0} Where [D0,D1,D2] bits are: LMK04282: bit [23] - 1-bit command field (R/W) bits [22:21] - 2-bit multi-byte field (W1, W0) bits [20:8] - 13-bit address field (A12 to A0) bits [7-0]- 8-bit data field (D7 to D0). LMX2594: bit [23] - 1-bit command field (R/W) bits [22:16] - 7-bit address field (A6 to A0) bits [15-0]- 16-bit data field (D15 to D0).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="gae0b716c787b95513649b2fcba33b3b95"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_ResetChip </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ChipId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to reset one of LMX2594 or LMK04828. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ChipId</td><td>indicates the RF clock chip Id.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group___overview.html#ga02dab3acd290a218e441d08199454338">XRFClk_WriteReg()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7820c4fffaa739e2c61e0ad2442e38d2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_SetConfigOnAllChipsFromConfigId </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ConfigId_LMK</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ConfigId_1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ConfigId_2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to set a full configuration on all LMX2594 and LMK04828 or LMK04208 for the requested frequency. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ConfigId_LMK</td><td>indicates the LMK configuration Id. </td></tr>
    <tr><td class="paramname">ConfigId_RF1</td><td>indicates the LMX RF1 configuration Id. </td></tr>
    <tr><td class="paramname">ConfigId_RF2</td><td>indicates the LMX RF2 configuration Id. </td></tr>
    <tr><td class="paramname">ConfigId_RF3</td><td>indicates the LMX RF3 configuration Id.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group___overview.html#ga64c1af6644e83e169033afab6abcf344">XRFClk_SetConfigOnOneChipFromConfigId()</a>.</p>

</div>
</div>
<a class="anchor" id="ga094020b0514371f05b8848e1454f0345"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_SetConfigOnOneChip </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ChipId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>CfgData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to set the full configuration data on one of LMX2594 or LMX04828. </p>
<p>The all register values are passed as a pointer CfgData, Len defines a number of data ready for writing.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ChipId</td><td>indicates the RF clock chip Id. </td></tr>
    <tr><td class="paramname">CfgData</td><td>indicates the configuration for all registers. </td></tr>
    <tr><td class="paramname">Len</td><td>indicates a number of data.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="group___overview.html#ga02dab3acd290a218e441d08199454338">XRFClk_WriteReg()</a>.</p>

</div>
</div>
<a class="anchor" id="ga64c1af6644e83e169033afab6abcf344"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_SetConfigOnOneChipFromConfigId </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ChipId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ConfigId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to set a full configuration on one of LMX2594 or LMX04828 for the requested frequency.where the register settings is provided from the selected hard coded data. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ChipId</td><td>indicates the RF clock chip Id. </td></tr>
    <tr><td class="paramname">ConfigId</td><td>indicates the RF clock chip configuration Id.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>Referenced by <a class="el" href="group__xrfclk.html#ga70661f1623b48f8230135120ab764eca">XRFClk_SetConfigOnAllChipsFromConfigId()</a>.</p>

</div>
</div>
<a class="anchor" id="ga02dab3acd290a218e441d08199454338"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XRFClk_WriteReg </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ChipId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>d</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to write a register on one of LMX2594 or LMX04828. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ChipId</td><td>indicates the RF clock chip Id. </td></tr>
    <tr><td class="paramname">d</td><td>= {D2, D1, D0} Where [D0,D1,D2] bits are: LMK04282: bit [23] - 1-bit command field (R/W) bits [22:21] - 2-bit multi-byte field (W1, W0) bits [20:8] - 13-bit address field (A12 to A0) bits [7-0]- 8-bit data field (D7 to D0). LMX2594: bit [23] - 1-bit command field (R/W) bits [22:16] - 7-bit address field (A6 to A0) bits [15-0]- 16-bit data field (D15 to D0).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>Referenced by <a class="el" href="group__xrfclk.html#ga91a0033a744f217741b6bf0125914407">XRFClk_ConfigOutputDividerAndMUXOnLMK()</a>, <a class="el" href="group__xrfclk.html#gaa084685a70d719dd933f735cb350fb95">XRFClk_ControlOutputPortLMK()</a>, <a class="el" href="group__xrfclk.html#gae0b716c787b95513649b2fcba33b3b95">XRFClk_ResetChip()</a>, and <a class="el" href="group__xrfclk.html#gaf97229ea09f7cf0d46fb4c1ee6f2f700">XRFClk_SetConfigOnOneChip()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
